Path: api/v1/docupload/{name}
This endpoint supports the following methods:
POST
Summary: Allows documents to be uploaded to Jim2. Documents can be related to one object in Jim2 (refer to the query parameters for this API).
Summary: Creates a new document.
Query Parameters
| Parameter | Optional | Description |
|---|---|---|
| category | ✓ | The category tag for the document. This category must already exist. |
| tag | ✓ | The tag for the document. This tag must already exist. |
| objreftype | ✓ | The type of object the document should be related to. Supported types are Job (objrefid must be the Job number) Quote (objrefid must be the Quote number) Purchase (objrefid must be the PO number) CardFile (objrefid must be the Card code) Items (objrefid must be the Item code) Stock (objrefid must be the Jim2 stock code, and the stock must be active) StockTransfer (objrefid must be the Transfer number) VendReturn (objrefid must be the Vendor Return number) CustReturn (objrefid must be the Customer Return number) StockAdj (objrefid must be the Stock Adjustment number) Debtors (objrefid must be the Card number of the debtor) Cheque (objrefid must be the Cheque transaction number) GJEntry (objrefid must be the General Journal entry reference number) Creditors (objrefid must be the Card number of the creditor) StockPack (objrefid must be the Packaging session number) StockTake (objrefid must be the Stock Take session number) Project (objrefid must be the Project code) StockPromoPricing (objrefid must be the Promo number) Asset (objrefid must be the Asset number) If specified the objrefid parameter is also required. |
| objrefid | ✓ | The object identifier, refer to objreftype. |